/*
 * Copyright (c) 2014-2024 Stream.io Inc. All rights reserved.
 *
 * Licensed under the Stream License;
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.getstream.chat.android.compose.ui.theme

/**
 * Class holding configuration for different keyboard behaviours.
 *
 * @param closeKeyboardOnAttachmentPickerOpen If true, the keyboard will be closed when the attachment picker is opened.
 */
public data class StreamKeyboardBehaviour(
    val closeKeyboardOnAttachmentPickerOpen: Boolean,
) {

    public companion object {

        /**
         * Builds the default keyboard behaviour.
         *
         * @return A [StreamKeyboardBehaviour] instance holding the default configuration.
         */
        public fun defaultBehaviour(): StreamKeyboardBehaviour {
            return StreamKeyboardBehaviour(closeKeyboardOnAttachmentPickerOpen = true)
        }
    }
}
